Add tests - #2

Adds a first set of automated unit/integration tests for key simulation components (plans, devices, image analysis, and the energy-alignment agent), and wires them into CI via Pixi-driven GitHub Actions workflows. This also includes small supporting tweaks in the production code to make image handling and typing more robust under test.

Changes:

• Add unit tests covering BMM plans, device signal contracts, detector streaming assets, image-analysis utilities, and agent wiring/evaluation.
• Add an integration round-trip test that writes HDF5 frames, ingests them via a local Tiled app, and evaluates outcomes end-to-end.
• Add pytest configuration + Pixi tasks and introduce CI workflows for unit tests (per-push/PR) and integration tests (scheduled).

• Files reviewed: 13/14 changed files
• Comments generated: 2
• Review effort level: Lite

Suppressed comments (5)

Previously missed (2) — in code that hasn't changed since the last review.

src/tst_sim_tools/agents/energy_alignment.py:88

• The evaluator fetches self._client[uid] twice (once in _poll_for_images and again to read metadata). This adds unnecessary client I/O and can reintroduce KeyError/inconsistencies if the catalog is eventually consistent; reuse the same run object instead.
  tests/unit/plans/test_bmm.py:320
• This assertion relies on the private _cache attribute of an ophyd-async signal, which is not part of the public API and may change across versions. Using getattr(..., None) keeps the test focused on cleanup without coupling it to internal implementation details.

This issue also appears in the following locations of the same file:

• line 335
• line 351
• line 418

tests/unit/plans/test_bmm.py:335

• This assertion relies on the private _cache attribute of an ophyd-async signal, which is not part of the public API and may change across versions. Using getattr(..., None) keeps the test focused on cleanup without coupling it to internal implementation details.

    assert detector._cache is None

tests/unit/plans/test_bmm.py:351

• This assertion relies on the private _cache attribute of an ophyd-async signal, which is not part of the public API and may change across versions. Using getattr(..., None) keeps the test focused on cleanup without coupling it to internal implementation details.

    assert detector._cache is None

tests/unit/plans/test_bmm.py:418

• This assertion relies on the private _cache attribute of an ophyd-async signal, which is not part of the public API and may change across versions. Using getattr(..., None) keeps the test focused on cleanup without coupling it to internal implementation details.

    assert sensor._cache is None

• Files reviewed: 13/14 changed files
• Comments generated: 0 new
• Review effort level: Lite

• Files reviewed: 14/15 changed files
• Comments generated: 2
• Review effort level: Lite

Suppressed comments (2)

Previously missed (1) — in code that hasn't changed since the last review.

tests/conftest.py:8

• Ruff/pycodestyle E402 will flag imports after executable statements. Since MPLBACKEND must be set before importing Matplotlib, add a targeted # noqa: E402 on the Matplotlib import.

tests/conftest.py:21

• collections.abc.Generator requires three type parameters (yield, send, return). Generator[RunEngine] is invalid and may fail at import time; annotate as Generator[RunEngine, None, None] for this yielding fixture.

def run_engine() -> Generator[RunEngine]:

• Files reviewed: 14/15 changed files
• Comments generated: 1
• Review effort level: Lite

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

tests/conftest.py:8

• This import comes after executable code (the MPLBACKEND environment set), which will trigger Ruff E402 if the tests are ever linted. If the backend must be set before importing Matplotlib, add a targeted noqa on the import line to document/justify the ordering.

• Files reviewed: 14/15 changed files
• Comments generated: 1
• Review effort level: Lite

Suppressed comments (3)

Previously missed (3) — in code that hasn't changed since the last review.

tests/integration/test_energy_alignment_round_trip.py:27

• EnergyAlignmentEvalutation is misspelled ("Evalutation" vs "Evaluation"). Consider exposing a correctly-spelled alias in the library and switching this integration test to use it, while retaining the existing name for compatibility.
  tests/unit/agents/test_energy_alignment.py:26
• EnergyAlignmentEvalutation is misspelled ("Evalutation" vs "Evaluation"). Adding more call sites in tests makes a future correction harder; consider introducing a correctly-spelled alias (keeping the old name for backward compatibility) and updating tests to use the alias.
  tests/unit/devices/test_devices.py:7
• XRTRectangularAperature is misspelled ("Aperature" vs "Aperture"). If you intend to fix the public API spelling eventually, consider adding a correctly-spelled alias and using it in tests to avoid propagating the typo.

• Files reviewed: 14/15 changed files
• Comments generated: 0 new
• Review effort level: Lite